getKeywordHistory

Returns a list of airplay histories for one or more specified keywords.

Sample Request

<mmRequest command="getKeywordHistory" station="ID" [version="1"] [client=""] [userData=""]>
	<contents>
		[<maxHistories>10</maxHistories>]
		[<archiveHistory>1</archiveHistory>]
		<keywordList>
			<keyword [fieldId="101"] [fieldName="Artist"] value="Beatles" />
		</keywordList>
	</contents>
</mmRequest>

Request Notes

maxHistories – the maximum number of histories that will be returned. By default, all available active histories will be returned. These always begin with the newest history and work backward in time.

 

archiveHistory - allows this command to include archived history. When set to "1", this allows the inclusion of archived history.

 

The keyword tags define the keywords that you wish to retrieve histories for. You must also indicate the keyword field to search. Fields can be specified by name or ID.

 

• fieldId – the MusicMaster Field ID to search
• fieldName – the name of the MusicMaster Field to search
• value – the Keyword you wish to search for

 

Note that while fieldId and fieldName are both listed as optional, one or the other must be included.

Sample Reply

<mmReply command="getKeywordHistory" station="ID" version="1" [userData=""] status="???????">
	<contents>
		<keywordList>
			<keyword fieldId="102" fieldName="Artist" value="Beatles">
				<historyList>
					<history historyId="1" airDate="yyyy-mm-dd" airTime="hh:mm:ss" runTime="mm:ss" />
				</historyList>
			</keyword>
		</keywordList>
	</contents>
</mmReply>

Compatibility and Version Info

Available with MusicMaster PRO 5.0sr14 and later